Order Notification API
How to use the API
Here’s an overview of the features included in this API, what they do and what you can use them for.
| API Feature | What it does | What it's used for |
|---|---|---|
| Get API Version | Retrieves the full version number of the API (major, minor and patch version numbers). | Viewing the API version. |
| Receive notifications relating to an order | Supplies order notifications as they occur. | Keeps you informed along an order lifecycle. |
| Receive notifications relating to a service | Supplies service notifications as they occur. | Informs you or changes and requests relating to services you own. |
Order statuses and substatuses
Fibre orders are managed using statuses and sub-statuses. As an order progresses (for example: when scoping and installation work are carried out), the order status changes.
Notes on statuses and sub-statuses:
- A fibre order can change sub-status without changing status. Generally, this occurs while an order is In Progress, and Chorus is actively working on it.
- When an order is In Progress, an action is sitting with Chorus or a Service Company to progress the order.
- When an order is in Held, Chorus is waiting on an action from the RSP.
- Depending on the scenarios that occur, an order could move between In Progress or Held multiple times during the fibre ordering process.
Order Notifications without a status change
These notifications are typically a manual notification or an event-based notification, which is not from one of your orders. These notifications are intended to keep you informed and, in some instances, require you to take further action.
Learn more about statuses and sub-statuses
Notification types
Notifications provide updates when the status of an order changes. The order notification types and associated attributes are described in the following tables.
Learn more about the Fibre APIs journey
Quick links
Note: These notification types are listed in alphabetical order. This does not represent the lifecycle of an order.
| Notification type | Description |
|---|---|
| ACKNOWLEDGED_ACCEPTED | Your submitted order was accepted by the system and contains network. |
| CEASE_BILLING | A service you owned was transferred to another provider. |
| CLOSED_COMPLETED | Your order is closed and all actions are completed. |
| COMPLETED_BILLING | The order's provisioning activities are completed and billing setup is in progress. |
| CONSENT_DECLINED | The consent required for your order was declined. The order will be referred for cancellation. |
| CONSENT_GAINED | The consent required for your order has been gained. The order will progress to the next stage. |
| CONSENT_REQUESTED | Your order requires consent which has been requested. Chorus is either awaiting a response or for the notification period to lapse before we can proceed. |
| CONSENT_REQUIRED | Your order requires consent which is being assessed. Chorus will notify or request consent from the required parties before proceeding. |
| ESCALATION_ACCEPTED | Your order was escalated and Chorus has accepted the escalation. |
| ESCALATION_COMPLETED | Your order was escalated and Chorus has completed the escalation. |
| ESCALATION_DECLINED | Your order was escalated and the escalation was declined by Chorus. |
| GENERATE_QUOTATION | A quote is being prepared for your order. |
| HELD_PENDING_DISCONNECT_ACCEPTANCE | Your order is pending another service being disconnected before Chorus can proceed. |
| HELD_PROVIDER_TO_ADVISE | Your order requires an answer to a question before Chorus can proceed. |
| HELD_SCHEDULE_INSTALL | Your order requires scheduling before Chorus can proceed. |
| HELD_SCHEDULE_SCOPING | Your order requires scheduling before Chorus can proceed. |
| IN_PROGRESS_INTENT_TO_CANCEL | The order is progressing through to be completely cancelled. |
| INTENT_TO_CANCEL | Chorus has supplied a reason for the order to be cancelled. |
| INTENT_TO_DISCONNECT_ABANDONMENT | When a Service Provider submits a request to abandon a service that may have been left connected at an address/location. |
| INTENT_TO_DISCONNECT_SECONDARY | When a Service Provider disconnects a Primary product offer where a Secondary product offer is connected. |
| INVESTIGATION_REQUIRED | When an exception scenario has been encountered during a site visit. |
| MANUAL_INTERACTION | Chorus have manually supplied an order update. |
| NETWORK_BUILD | The order requires network build which will be completed prior to the order proceeding to scheduling. |
| NETWORK_DESIGN | The order may require network design which needs to be assessed before proceeding with the order. |
| NOTIFY_ADDITIONAL_SERVICE | A Service Provider has connected an additional Primary service to an ONT that you have an active service on. |
| QUOTE_ACCEPTANCE | You need to accept the quote to proceed. |
| REJECT_CANCEL | The cancellation request initiated by Chorus was rejected by you. |
| RFS_CONFIRMED | The request for service date and time is confirmed. |
| SCHEDULED | The order is scheduled for a site visit appointment. |
| SCOPING_SCHEDULED | The order’s scope is scheduled for an appointment. |
| SERVICE_GIVEN | The orders provisioning activities are completed and billing setup will be initiated. |
| STATUS | Chorus have manually supplied an order update. |
| STATUS_WITH_NOTE | Chorus have manually supplied an order update. |
| SVM_EVENT | The Service Company has updated the scheduled appointment for the order. |
| UPDATE_ORDER_DETAILS | Chorus have manually supplied an order update. |
ACKNOWLEDGED_ACCEPTED
When will I receive this notification?
Your submitted order was accepted by the system and contains product characteristics.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification identifier |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID the notification is associated to |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.productId | Product ID for the order of the order |
| order.orderState | Current status/state of an order |
| order.orderSubstate | Current substatus/substate of an order |
| order.orderDateTime | Time and date order was created |
| order.connectRFSDateTime OR order.disconnectRFSDateTime | Connect or disconnect date/time for the order |
| order.productOfferDetails.productOfferId | Product offer ID for the service |
| order.productOfferDetails.productOfferName | Product offer name for the service |
| order.productOfferDetails.productCharacteristics | Product offers product characteristics (in name value pairs) |
| order.cseProductOfferDetails.productOfferId | Product offer id for the CSE |
| order.cseProductOfferDetails.productOfferName | Product offer name for the CSE |
| order.cseProductOfferDetails.orderItemId | Internal order reference |
| order.cseProductOfferDetails.productCharacteristics | CSE Product offers product characteristics (in name value pairs) |
CEASE_BILLING
When will I receive this notification?
A service you owned was transferred to another provider.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| existingPlaceId | Existing address/location of the service |
| existingProductId | Existing Product ID for the service that billing has ceased for |
CLOSED_COMPLETED
When will I receive this notification?
Your order is closed and all actions are completed.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place unique identifier |
| order.productId | Product unique identifier |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Time and date the order was created |
| order.connectRFSDateTime OR order.disconnectRFSDateTime | Connect or disconnect RFS date/time for the order |
| order.ordercharges.category | Category of the charge |
| order.ordercharges.productOfferName | Product offer name |
| order.ordercharges.chargeType | Type of charge for the category |
| order.ordercharges.unitCost | Unit cost in dollars for the category selected |
| order.ordercharges.quantity | Quantity of category selected based on unit cost |
| order.ordercharges.value | Total value in dollars of the category selected |
| billingDetails.billingAccount | Billing account for order charges to be associated with |
| billingDetails.billingEffectiveDate | The date the service will be billed from |
| billignDetails.billingTotal | Total value in dollars of the order |
COMPLETED_BILLING
When will I receive this notification?
The order's provisioning activities are completed and billing setup is in progress.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place unique identifier |
| order.productId | Product unique identifier |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Time and date the order was created |
| order.connectRFSDateTime OR order.disconnectRFSDateTime | Connect or disconnect RFS date/time for the order |
CONSENT_DECLINED
When will I receive this notification?
The consent required for your order was declined. The order will be referred for cancellation.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| notificationNote | Applicable notes/comments associated to the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place unique identifier |
| order.productId | Product unique identifier |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Time and date the order was created |
| order.consentStatus | Consent status of the location |
| order.consentCategory | Consent category of the location |
| order.reason.code | Reason code for the cancellation |
| order.reason.description | Description of the cancellation reason code used |
CONSENT_GAINED
When will I receive this notification?
The consent required for your order has been gained. The order will progress to the next stage.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| notificationNote | Applicable notes/comments associated to the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place unique identifier |
| order.productId | Product unique identifier |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Time and date the order was created |
| order.consentStatus | Consent status of the location |
| order.consentCategory | Consent category of the location |
CONSENT_REQUESTED
When will I receive this notification?
Your order requires consent, which has been requested. Chorus is either awaiting a response, or for the notification period to lapse before we can proceed.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| notificationNote | Applicable notes/comments associated to the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place unique identifier |
| order.productId | Product unique identifier |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Time and date the order was created |
| order.consentStatus | Consent status of the location |
| order.consentCategory | Consent category of the location |
CONSENT_REQUIRED
When will I receive this notification?
Your order requires consent which is being assessed. Chorus will notify or request consent from the required parties before proceeding.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| notificationNote | Applicable notes/comments associated to the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place unique identifier |
| order.productId | Product unique identifier |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Time and date order was created |
| order.consentStatus | Consent status of the location |
| order.consentCategory | Consent category of the location |
ESCALATION_ACCEPTED
When will I receive this notification?
Your order was escalated and Chorus has accepted the escalation.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| notificationNote | Applicable notes/comments associated to the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.productId | Product ID for the order |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.escalationDetails.escalated | Flag to indicate the order is escalated |
| order.escalationDetails.escalationReason | Reason code for the escalation |
| order.escalationDetails | Comments or associated information supplied about the escalation |
ESCALATION_COMPLETED
When will I receive this notification?
Your order was escalated and Chorus has completed the escalation.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| notificationNote | Applicable notes/comments associated to the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.productId | Product ID for the order |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.escalationDetails.escalated | Flag to indicate if the order was escalated |
| order.escalationDetails.escalationReason | Reason code for the escalation |
| order.escalationDetails.escalationComment | Comments or associated information supplied about the escalation |
ESCALATION_DECLINED
When will I receive this notification?
Your order was escalated and the escalation was declined by Chorus.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| notificationNote | Applicable notes/comments associated to the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.productId | Product ID for the order |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.escalationDetails.escalated | Flag to indicate if the order was escalated |
| order.escalationDetails.escalationReason | Reason code for the escalation |
| order.escalationDetails.escalationComment | Comments or associated information supplied about the escalation |
GENERATE_QUOTATION
When will I receive this notification?
A quote is being prepared for your order
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | vDate and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.productId | Product ID for the order |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
HELD_PENDING_DISCONNECT_ACCEPTANCE
When will I receive this notification?
Your order is pending another service being disconnected before Chorus can proceed.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.previousProductDetails.previousProductId | Previous Product ID for the order |
HELD_PROVIDER_TO_ADVISE
When will I receive this notification?
Your order requires an answer to a question before Chorus can proceed.
What do I need to do when I receive this notification?
Chorus requires you to answer the question from the notification or with no response your order may be cancelled.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.reason.code | Latest reason code used on the order |
| order.reason.note | Comments or associated information corresponding to the latest reason code used on the order |
| order.question.questionId | Question ID for the scenario |
| order.question.questionValue | Associated questionValue text for scenario |
| order.question.validityStartDateTime | Start date and time that the question is valid from |
| order.question.validityEndDateTime | End date and time that the question is valid for and an answer is required by |
HELD_SCHEDULE_INSTALL
When will I receive this notification?
Your order requires scheduling before Chorus can proceed.
What do I need to do when I receive this notification?
Chorus requires you to schedule an appointment for the order.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| notificationNote | Applicable notes/comments associated to the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.siteVisits.siteVisitId | Site visit ID |
| order.siteVisits.bookable | Flag to indicate if site visit is bookable |
| order.siteVisits.siteVisitType | Purpose (type) of the site visit |
| order.siteVisits.siteVisitAppointment.startDateTime | Start date for available site visit appointment reservation |
| order.siteVisits.siteVisitAppointment.endDateTime | End date for available site visit appointment reservation |
HELD_SCHEDULE_SCOPING
When will I receive this notification?
Your order requires scheduling before Chorus can proceed.
What do I need to do when I receive this notification?
Chorus requires you to schedule the scope and install date and time for the order.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| notificationNote | Applicable notes/comments associated to the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.siteVisits.siteVisitId | Site visit ID |
| order.siteVisits.bookable | Flag to indicate if site visit is bookable |
| order.siteVisits.siteVisitType | Purpose (type) of the site visit |
| order.siteVisits.siteVisitAppointment.startDateTime | Start date for available site visit appointment reservation |
| order.siteVisits.siteVisitAppointment.endDateTime | End date for available site visit appointment reservation |
IN_PROGRESS_INTENT_TO_CANCEL
When will I receive this notification?
The order is progressing through to be completely cancelled
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.reason.code | Reason code for the cancellation |
| order.reason.description | Reason for the cancellation |
| order.reason.note | Comments or associated information corresponding to the cancel reason used on the order |
INTENT_TO_CANCEL
When will I receive this notification?
Chorus has supplied a reason for the order to be cancelled.
What do I need to do when I receive this notification?
Chorus requires you to answer the question from the notification. With no response your order will be cancelled.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.question.questionId | Question ID for the scenario |
| order.question.questionValue | Associated questionValue text for scenario |
| order.reason.code | The applicable reason code |
| order.reason.description | The description of Latest reason code used on the order |
INTENT_TO_DISCONNECT_ABANDONMENT
When will I receive this notification?
When a Service Provider submits a request to abandon a service that may have been left connected at an address/location.
What do I need to do when I receive this notification?
Chorus requires you to answer the question from the notification. With no response your service will be disconnected.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.placeId | Place ID of the location/address |
| order.productId | Product ID for the order |
| order.orderDateTime | Date and time of order creation |
| order.disconnectRFSDateTime | The disconnect RFS date/time for the order |
| order.question.questionId | Question ID for the scenario |
| order.question.questionValue | Associated questionValue text for scenario |
| order.question.validityStartDateTime | Start date and time that the question is valid from |
| order.question.validityEndDateTime | End date and time that the question is valid for and an answer is required by |
INTENT_TO_DISCONNECT_SECONDARY
When will I receive this notification?
When a Service Provider disconnects a Primary product offer where a Secondary product offer is connected.
What do I need to do when I receive this notification?
Chorus requires you to answer the question from the notification. With no response your service will be disconnected.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.placeId | Place ID of the location/address |
| order.productId | Product ID for the order |
| order.orderDateTime | Date and time of order creation |
| order.disconnectRFSDateTime | The disconnect RFS date/time for the order |
| order.question.questionId | Question ID for the scenario |
| order.question.questionValue | Associated questionValue text for scenario |
| order.question.validityStartDateTime | Start date and time that the question is valid from |
| order.question.validityEndDateTime | End date and time that the question is valid for and an answer is required by |
INVESTIGATION_REQUIRED
When will I receive this notification?
When an exception scenario has been encountered during a site visit.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| activity | Reason for the delay |
| expectedResolutionDate | Date and time a resolution is expected by |
| nextUpdateBy | Date and time an update is expected by |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
MANUAL_INTERACTION
When will I receive this notification?
Chorus have manually supplied an order update
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| notificationNote | Applicable notes/comments associated to the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| orderDateTime | Date and time of order submission. |
| order.connectRFSDateTime OR order.disconnectRFSDateTime | Connect or Disconnect RFS date/time for the order |
| order.siteVisits.siteVisitId | Site visit ID |
| order.siteVisits.bookable | Flag to indicate if site visit is bookable |
| order.siteVisits.siteVisitType | Type of site visit |
NETWORK_BUILD
When will I receive this notification?
The order requires network build, which will be completed prior to the order proceeding to scheduling.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| notificationNote | Applicable notes/comments associated to the notification |
| activity | Reason for the delay |
| expectedResolutionDate | Date and time a resolution is expected to be provided by |
| nextUpdateBy | Date and time the next update is expected to be provided by |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
NETWORK_DESIGN
When will I receive this notification?
The order may require network design| which needs to be assessed before proceeding with the order.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| activity | Reason for the delay |
| expectedResolutionDate | Date and time a resolution is expected to be provided by |
| nextUpdateBy | Date and time the next update is expected to be provided by |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
NOTIFY_ADDITIONAL_SERVICE
When will I receive this notification?
A Service Provider has connected an additional Primary service to an ONT that you have an active service on.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| existingPlaceId | Existing address/location of the service |
| existingProductId | Existing Product ID for the service that billing has ceased for |
QUOTE_ACCEPTANCE
When will I receive this notification?
You need to accept the quote to proceed
What do I need to do when I receive this notification?
Chorus requires you to answer the question from the notification. With no response your order may be cancelled.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.question.questionId | Question ID for the scenario |
| order.question.questionValue | Associated questionValue text for scenario |
| order.question.validityStartDateTime | Start date and time that the question is valid from |
| order.question.validityEndDateTime | End date and time that the question is valid for and an answer is required by |
| order.quote.value | Quote total value |
| order.quote.validityEndDateTime | End date and time that the quote is valid for and an answer is required by |
| order.quote.status | Quote current status |
| order.quote.description | Description of the quote details |
REJECT_CANCEL
When will I receive this notification?
The cancellation request initiated by Chorus was rejected by you.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.connectRFSDateTime OR order.disconnectRFSDateTime | Connect or Disconnect RFS date/time for the order |
RFS_CONFIRMED
When will I receive this notification?
The request for service date and time is confirmed| as well as the product characteristics.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.productId | Product ID for the order |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.connectRFSDateTime OR order.disconnectRFSDateTime | Connect or Disconnect RFS date/time for the order |
| order.productOfferDetails.productOfferId | Product Offer ID for the service |
| order.productOfferDetails.productOfferName | Product Offer Name for the service |
| order.productOfferDetails.productCharacteristics | Product offers product characteristics (in name value pairs) |
| order.cseProductOfferDetails.productOfferId | Product Offer ID for the CSE |
| order.cseProductOfferDetails.productOfferName | Product Offer Name for the CSE |
| order.cseProductOfferDetails.productCharacteristics | CSE Product offers product characteristics (in name value pairs) |
SCHEDULED
When will I receive this notification?
The order is scheduled for a site visit appointment.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.connectRFSDateTime OR order.disconnectRFSDateTime | Connect or Disconnect RFS date/time for the order |
| order.siteVisits.siteVisitId | Site visit ID |
| order.siteVisits.bookable | Flag to indicate if site visit is bookable |
| order.siteVisits.siteVisitType | Purpose (type) of the site visit |
| order.siteVisits.siteVisitAppointment.startDateTime | Start date for available site visit appointment reservation |
| order.siteVisits.siteVisitAppointment.endDateTime | End date for available site visit appointment reservation |
SCOPING_SCHEDULED
When will I receive this notification?
The order’s scope is scheduled for an appointment
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.connectRFSDateTime | The connect RFS date/time for the order |
| order.siteVisits.siteVisitId | Site visit ID |
| order.siteVisits.bookable | Flag to indicate if site visit is bookable |
| order.siteVisits.siteVisitType | Purpose (type) of the site visit |
| order.siteVisits.siteVisitAppointment.startDateTime | Start date for available site visit appointment reservation |
| order.siteVisits.siteVisitAppointment.endDateTime | End date for available site visit appointment reservation |
SERVICE_GIVEN
When will I receive this notification?
The orders provisioning activities are completed and billing setup will be initiated.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.connectRFSDateTime OR order.connectRFSDateTime | Connect or Disconnect RFS date/time for the order |
| serviceGivenDateTime | Date and time the order went to status: Service Given |
| order.productOfferDetails.productOfferId | Product Offer ID for the service |
| order.productOfferDetails.productOfferName | Product Offer Name for the service |
| order.productOfferDetails.productCharacteristics | Product offers product characteristics (in name value pairs) |
| order.cseProductOfferDetails.productOfferId | Product Offer ID for the CSE |
| order.cseProductOfferDetails.productOfferName | Product Offer Name for the CSE |
| order.cseProductOfferDetails.productCharacteristics | CSE Product offers product characteristics (in name value pairs) |
STATUS
When will I receive this notification?
Chorus have manually supplied an order update.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.productId | Product ID for the order |
| orderDateTime | Date and time of order submission. |
| order.connectRFSDateTime OR order.disconnectRFSDateTime | Connect or Disconnect RFS date/time for the order |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
STATUS_WITH_NOTE
When will I receive this notification?
Chorus have manually supplied an order update.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| notificationNote | Applicable notes/comments associated to the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| orderDateTime | Date and time of order submission. |
| order.connectRFSDateTime OR order.connectRFSDateTime | Connect or Disconnect RFS date/time for the order |
SVM_EVENT
When will I receive this notification?
The Service Company has updated the scheduled appointment for the order.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| notificationNote | Applicable notes/comments associated to the notification |
| eventDescription | Applicable system generated message associated to the site visit manager event |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
| order.connectRFSDateTime OR order.disconnectRFSDateTime | Connect or Disconnect RFS date/time for the order |
| order.siteVisits.siteVisitId | Site visit ID |
| order.siteVisits.bookable | Flag to indicate if site visit is bookable |
| order.siteVisits.siteVisitType | Purpose (type) of the site visit |
UPDATE_ORDER_DETAILS
When will I receive this notification?
Chorus have manually supplied an order update.
What do I need to do when I receive this notification?
Chorus does not require you to take any action. This is for your information only. You can choose to inform your customers of this update.
| Attribute | Description |
|---|---|
| id | Notification ID |
| notificationMajorVersion | Notification major version reference |
| notificationType | Type of notification being sent |
| notificationCategory | Category of notification |
| notificationDateTime | Date and time the notification was sent |
| notificationMessage | Applicable system generated message associated with the notification |
| notificationNote | Applicable notes/comments associated to the notification |
| order.id | Customer order ID |
| order.orderType | Order type |
| order.providerReference | Customer/Service Provider reference |
| order.placeId | Place ID of the location/address |
| order.orderState | Current status/state of the order |
| order.orderSubstate | Current substatus/substate of the order |
| order.orderDateTime | Date and time of order creation |
questionValue messages
Some notifications have questions associated with them that require an answer within a given timeframe to progress the order. The following question values, associated notification types and validity timeframes apply.
| Question value | notificationType | Validity |
|---|---|---|
| A request has been made to cancel this order - Please confirm if you ACCEPT or REJECT this request | INTENT_TO_CANCEL | Up to 5 days |
| Please check with your end customer and either ACCEPT or REJECT this request. | INTENT_TO_DISCONNECT_ABANDONMENT | Up to 5 days |
| Please confirm if you ACCEPT or REJECT this request. | INTENT_TO_DISCONNECT_SECONDARY | Up to 5 days |
| Please confirm if you ACKNOWLEDGE, REJECT or wish to EXTEND by 7,14,21,28 days this request. | HELD_PROVIDER_TO_ADVISE | Up to 28 days |
| A quote has been added to this order - Please confirm if you APPROVE or REJECT the supplied quote | QUOTE_ACCEPTANCE | Up to 90 days |
Learn more about amending an order via the Manage Order API
Notification messages
Some notifications have messages associated with them, which provide a brief summary of the notification supplied. The following notification types have associated message values.
| notificationType | Message value |
|---|---|
| CEASE_BILLING | We have received a request to transfer <productOfferName> Product ID for the order <productId>. Billing for this connection will cease from <endBillingDateTime> |
| CLOSED_COMPLETED | Your customer order has been completed |
| COMPLETED_BILLING | Your customer order billing is being processed |
| CONSENT_DECLINED | Consent has been declined for your customer order |
| CONSENT_GAINED | Consent has been gained for your customer order |
| CONSENT_REQUESTED | Consent has been requested for your customer order |
| CONSENT_REQUIRED | Consent is required for your customer order |
| ESCALATION_ACCEPTED | Chorus has accepted escalation of your customer order |
| ESCALATION_COMPLETED | Chorus has completed escalation of your customer order |
| ESCALATION_DECLINED | Chorus has declined escalation of your customer order |
| GENERATE_QUOTATION | A quote is being generated for your customer order |
| HELD_PENDING_DISCONNECT_ACCEPTANCE | Your customer order is awaiting disconnect acceptance of a linked replace order |
| HELD_PROVIDER_TO_ADVISE UPDATE_ORDER_DETAILS | Your customer order requires advisement |
| HELD_SCHEDULE_INSTALL | Your customer order requires scheduling of an install appointment site visit |
| HELD_SCHEDULE_SCOPING | Your customer order requires scheduling of a scope appointment site visit |
| IN_PROGRESS_INTENT_TO_CANCEL | Cancellation has been initiated for your customer order |
| INTENT_TO_CANCEL | A request has been made to cancel your customer order - If this request is Rejected you must provide the reason for the rejection in order for Chorus to progress the order |
| INTENT_TO_DISCONNECT_ABANDONMENT | Chorus has created a customer order on your behalf to disconnect a primary customer product instance |
| INTENT_TO_DISCONNECT_SECONDARY | Chorus has created a customer order on your behalf to disconnect a secondary product instance |
| INVESTIGATION_REQUIRED | Your customer order requires investigation due to problems encountered during provisioning |
| MANUAL_INTERACTION STATUS_WITH_NOTE STATUS | A status update has been given for your customer order |
| NETWORK_BUILD | Chorus has placed your customer order into network build |
| NETWORK_DESIGN | Chorus has put your customer order into network design |
| NOTIFY_ADDITIONAL_SERVICE | We have received a request to notify you of an additional service provisioned to Location ID: <placeId>. The service was connected at <connectRFSDateTime> This may indicate an existing customer has left the property or connected with another service provider We recommend you review if your end customer wishes to retain their existing service. Product ID for the order: <productId> |
| QUOTE_ACCEPTANCE | Your customer order requires quote acceptance |
| REJECT_CANCEL | Your customer order cancellation has been rejected |
| RFS_CONFIRMED | Your customer order RFS datetime is confirmed |
| SCHEDULED | Your customer order is scheduled for network activation |
| SCOPING_SCHEDULED | Your scope appointment has been scheduled |
| SERVICE_GIVEN | Your customer order has been fulfilled |
| SVM_EVENT | Your customer order site visit has been updated |